Skip to main content

Unity SDK

Let's Learn How to Use the ProVizXR UnitySDK
2-13-23

info

30 Minute Read 🕗

1 out of 5
ProVizXR Unity SDK is recommended to be used with Unity 2022.1 or later.

Adding the SDK​

  • Get a copy of the SDK (Link will be provided, reach out if you need it)
  • Copy the SDK folder to your project
  • Everything is self contained and wil adapt as additional libraries are added (like MRTK, Vuplex, etc.)

Creating a Custom Widget in ProVizXR Studio​

  • In studio, in the Advanced tab of the Widgets Panel, click Custom.
  • Provide a Custom Type that will match (case-sensitive) to the widget you'll create in Unity
  • Save your scene

Create a Custom Widget in Unity​

  • Create a new C# Script
  • Inherit from ProVizXR.CustomWidget

Packaging Service​

  • Create an Empty Prefab
  • Create a new ProVizXR Module Service

Authentication​

  • API Config
  • Machine Keys
  • Personal Access Token
  • Public Scenes

Testing a scene in Unity​

  • Get your Scene's ID
  • Open the Unity 'ProVizXRScene' Scene

Custom Events & Services​

  • Service - functionality on your widget
  • Event - events that your widget can emit
  • Connecting to the Flow Editor

Configuring a Custom Widget​

  • Data property
  • Using JSON and deserializing

Optional supported paid libaries​

  • Vuplex
  • RenderHeads

Lesson Complete

⭐️ ⭐️ ⭐️